Description | Example | Return Message | Group(s)

SCHED: GetTaskGroupReport

Format

SCHED / GetTaskGroupReport '<TaskGroupName>' '<FileName>'

Description

The SCHED GetTaskGroupReport Connect command returns a detailed report of the task group/(s) specified by the <TaskGroupName> parameter.

Parameters

  • TaskGroupName: The parameter is a string of text in single quotes of a comma delimited list of task groups. Task group names should not be in quotes and "ALL" may be used to return all task groups present in the schedule. Supports the use of wildcards.
  • FileName: The parameter is a string of text in single quotes of the absolute path file name. Empty string is allowed if it is not written out to a file.

Examples

Requests all Task Group reports for the active schedule to the file "out.txt" located at "C:\Outputs\"
SCHED / GetTaskGroupReport 'ALL' 'C:\Outputs\out.txt'

SyntaxExample
<CommandName>SCHED / GetTaskGroupReport
<TaskGroupName>'ALL'
<FileName>'C:\Outputs\out.txt'

Return Message

Connect returns a message that contains all of the report data for the task group(s). The report matches the format specified on the Task Group Report Details page.


Group Membership

This command belongs to the following group(s):

Scheduler

Version

10.1